HarmonyOS-鸿蒙app开发 —基于java_数据管理_对象关系映射数据库开发指导

场景介绍

对象关系映射数据库适用于开发者使用的数据可以分解为一个或多个对象，且需要对数据进行增删改查等操作，但是不希望编写过于复杂的SQL语句的场景。

该对象关系映射数据库的实现是基于关系型数据库，除了数据库版本升降级等场景外，操作对象关系映射数据库一般不需要编写SQL语句，但是仍然要求使用者对于关系型数据库的基本概念有一定的了解。

开发能力介绍

对象关系映射数据库目前可以支持数据库和表的创建，对象数据的增删改查、对象数据变化回调、数据库升降级和备份等功能。

数据库和表的创建

开发步骤

1. 配置“build.gradle”文件。

如果使用注解处理器的模块为“com.huawei.ohos.hap”模块，则需要在模块的“build.gradle”文件的ohos节点中添加以下配置：

compileOptions{

annotationEnabled true

}

如果使用注解处理器的模块为“com.huawei.ohos.library”模块，则需要在模块的“build.gradle”文件的“dependencies”节点中配置注解处理器。

如果使用注解处理器的模块为“java-library”模块，则需要在模块的“build.gradle”文件的dependencies节点中配置注解处理器，并导入“ohos.jar”。

dependencies {

compile files(“ohos.jar的路径”,“orm_annotations_java.jar的路径”,“orm_annotations_processor_java.jar的路径”,“javapoet_java.jar的路径”)

annotationProcessor files(“orm_annotations_java.jar的路径”,“orm_annotations_processor_java.jar的路径”,“javapoet_java.jar的路径”)

}

构造数据库，即创建数据库类并配置对应的属性。

构造数据表，即创建数据库实体类并配置对应的属性（如对应表的主键，外键等）。数据表必须与其所在的数据库在同一个模块中。

例如，定义了一个实体类User.java，对应数据库内的表名为“user”；indices 为“firstName”和“lastName”两个字段建立了复合索引“name_index”，并且索引值是唯一的；“ignoredColumns”表示该字段不需要添加到“user”表的属性中。

@Entity(tableName = “user”, ignoredColumns = {“ignoredColumn1”, “ignoredColumn2”},

indices = {@Index(value = {“firstName”, “lastName”}, name = “name_index”, unique = true)})

public class User extends OrmObject {

// 此处将userId设为了自增的主键。注意只有在数据类型为包装类型时，自增主键才能生效。

@PrimaryKey(autoGenerate = true)

private Integer userId;

private String firstName;

private String lastName;

private int age;

private double balance;

private int ignoredColumn1;

private int ignoredColumn2;

// 需添加各字段的getter和setter方法。

}

使用对象数据操作接口OrmContext创建数据库。

例如，通过对象数据操作接口OrmContext，创建一个别名为“BookStore”，数据库文件名为“BookStore.db”的数据库。如果数据库已经存在，执行以下代码不会重复创建。通过context.getDatabaseDir()可以获取创建的数据库文件所在的目录。

// context入参类型为ohos.app.Context，注意不要使用slice.getContext()来获取context，请直接传入slice，否则会出现找不到类的报错。

DatabaseHelper helper = new DatabaseHelper(this);

OrmContext context = helper.getOrmContext(“BookStore”, “BookStore.db”, BookStore.class);

（可选）数据库升降级。如果开发者有多个版本的数据库，通过设置数据库版本迁移类可以实现数据库版本升降级。

TestOrmMigration12的实现示例如下：

private static class TestOrmMigration12 extends OrmMigration {

// 此处用于配置数据库版本迁移的开始版本和结束版本，super(startVersion, endVersion)即数据库版本号从1升到2。

public TestOrmMigration12() {super(1, 2); }

@Override

public void onMigrate(RdbStore store) {

store.executeSql(“ALTER TABLE `Book` ADD COLUMN `addColumn12` INTEGER”);

}

}

使用对象数据操作接口OrmContext对数据库进行增删改查、注册观察者、备份数据库等。

• 更新或删除数据，分为两种情况：

通过直接传入OrmObject对象的接口来更新数据，需要先从表中查到需要更新的User对象列表，然后修改对象的值，再调用更新接口持久化到数据库中。删除数据与更新数据的方法类似，只是不需要更新对象的值。

例如，更新“user”表中age为“29”的行，需要先查找“user”表中对应数据，得到一个User的列表。然后选择列表中需要更新的User对象（如第0个对象），设置需要更新的值，并调用update接口传入被更新的User对象。最后调用flush接口持久化到数据库中。

// 更新数据

OrmPredicates predicates = context.where(User.class);

predicates.equalTo(“age”, 29);

List<User> users = context.query(predicates);

User user = users.get(0);

user.setFirstName(“Li”);

context.update(user);

context.flush();

// 删除数据

OrmPredicates predicates = context.where(User.class);

predicates.equalTo(“age”, 29);

List<User> users = context.query(predicates);

User user = users.get(0);

context.delete(user);

context.flush();

通过传入谓词的接口来更新和删除数据，方法与OrmObject对象的接口类似，只是无需flush就可以持久化到数据库中。

ValuesBucket valuesBucket = new ValuesBucket();

valuesBucket.putInteger(“age”, 31);

valuesBucket.putString(“firstName”, “ZhangU”);

valuesBucket.putString(“lastName”, “SanU”);

valuesBucket.putDouble(“balance”, 300.51);

OrmPredicates update = context.where(User.class).equalTo(“userId”, 1);

context.update(update, valuesBucket);

查询数据。在数据库的“user”表中查询lastName为“San”的User对象列表，示例如下：

OrmPredicates query = context.where(User.class).equalTo(“lastName”, “San”);

List<User> users = context.query(query);

注册观察者。

// 定义一个观察者类。

private class CustomedOrmObjectObserver implements OrmObjectObserver {

@Override

public void onChange(OrmContext changeContext, AllChangeToTarget subAllChange) {

// 用户可以在此处定义观察者行为

}

}

// 调用registerEntityObserver方法注册一个观察者observer。

CustomedOrmObjectObserver observer = new CustomedOrmObjectObserver();

context.registerEntityObserver(“user”, observer);

// 当以下方法被调用，并flush成功时，观察者observer的onChange方法会被触发。其中，方法的入参必须为User类的对象。

public <T extends OrmObject> boolean insert(T object)

public <T extends OrmObject> boolean update(T object)

public <T extends OrmObject> boolean delete(T object)

备份数据库。其中原数据库名为“OrmTest.db”，备份数据库名为“OrmBackup.db”。

OrmContext context = helper.getObjectContext(“OrmTest”, “OrmTest.db”, BookStore.class);

context.backup(“OrmBackup.db”);

context.close();

删除数据库，例如删除OrmTest.db。

helper.deleteRdbStore(“OrmTest.db“);